Update references to 1.2 spec, re-ordering, content updates #9

a-mile · 2025-07-23T19:49:57Z

This branch updates the tutorial to reference the 1.2 spec. It also addresses suggestions for updating content in preparation for the upcoming ACM Rep conference. These include:

Re-ordered lessons so that root data entity comes before metadata entity
Moved "Add an additional type" from cross references to root (seemed to make more sense there)
Added some abbreviations
Fleshed out the cross references lesson a bit more
Updated contextual entities to use instrument as an example as opposed to license. If this doesn't make sense I can change it back, it just seems a little clearer as an example of a context entity (since license can be data or context.)
Took out section to override the license
Added common pitfalls lesson
Extended next steps
Fixed a few typos

github-actions · 2025-07-23T19:50:09Z

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

🎯 correct output
🖼️ correct figures
❓ new warnings
‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/ResearchObject/packaging_data_with_ro-crate/compare/md-outputs..md-outputs-PR-9

The following changes were observed in the rendered markdown documents:

 01-introduction.md                          |  23 +++--
 02-folder-as-crate-root.md                  |  11 ++-
 03-metadata-descriptor.md                   |  30 +++++--
 04-root.md                                  |  56 ++++++++-----
 05-root-metadata.md                         |  11 +--
 06-cross-references.md                      |  85 ++++++++++---------
 07-data-entities.md                         |  12 ++-
 08-contextual-entities.md                   |  53 ++++++++++--
 09-authorship.md                            |   6 +-
 10-validating.md                            |   9 +-
 11-triples.md                               |   4 +-
 12-html-preview.md                          |  27 ++----
 13-complete.md                              |  27 +++---
 14-next-steps.md                            |  23 +++--
 15-common-pitfalls.md (new)                 | 125 ++++++++++++++++++++++++++++
 CODE_OF_CONDUCT.md                          |   4 +
 LICENSE.md                                  |   2 +-
 config.yaml                                 |   3 +-
 files/rainfall-1.2.1/index.html             |   6 +-
 files/rainfall-1.2.1/ro-crate-metadata.json |   6 +-
 files/rainfall-1.2.1/ro-crate-preview.html  |   6 +-
 index.md                                    |   2 +-
 md5sum.txt                                  |  37 ++++----
 23 files changed, 379 insertions(+), 189 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2025-07-25 08:52:06 +0000

a-mile · 2025-07-23T20:22:04Z

There is a validation failure in the new lesson file that my local build isn't picking up, I will get back to it tomorrow morning to troubleshoot.

elichad

Thanks for these updates @a-mile ! I've made some suggestions for clarity and such but on the whole these look like good changes.

episodes/14-common-pitfalls.md

episodes/08-contextual-entities.md

episodes/14-common-pitfalls.md

episodes/15-next-steps.md

index.md

Co-authored-by: Eli Chadwick <[email protected]>

elichad · 2025-07-25T08:39:07Z

episodes/03-metadata-descriptor.md

I think you renamed these three the wrong way round - this one should have become 04-root.md and so on (the content no longer matches the filename). I'll fix that and then merge

elichad · 2025-07-25T08:50:26Z

episodes/04-root.md

 }
 ```

-:::::::::::::::::::::::::::::::::::::::: callout


I missed this first time through, but I think we should move this section to where we add the metadata descriptor.

I made a commit for this, hopefully it is not contentious :)

elichad

I'm happy with this now, thanks again @a-mile !

elichad · 2025-07-25T08:57:08Z

Merging now so we have plenty of time to check that all the changes show up correctly on the website

Auto-generated via `{sandpaper}` Source : c82ddf7 Branch : main Author : Eli Chadwick <[email protected]> Time : 2025-07-25 08:57:20 +0000 Message : Merge pull request #9 from a-mile/acm_rep_updates Update references to 1.2 spec, re-ordering, content updates

Auto-generated via `{sandpaper}` Source : a66e0ab Branch : md-outputs Author : GitHub Actions <[email protected]> Time : 2025-07-25 08:58:20 +0000 Message : markdown source builds Auto-generated via `{sandpaper}` Source : c82ddf7 Branch : main Author : Eli Chadwick <[email protected]> Time : 2025-07-25 08:57:20 +0000 Message : Merge pull request #9 from a-mile/acm_rep_updates Update references to 1.2 spec, re-ordering, content updates

a-mile added 3 commits July 22, 2025 19:07

Updates for 1.2 and suggestions from ACM run through

4a2c63d

fix issue causing build to fail, additional 1.1->1.2 updates

5654b5e

formatting updates, fix typos

38084fd

a-mile requested a review from elichad July 23, 2025 19:49

close challenge block, remove white spaces

3a9ca6c

elichad reviewed Jul 24, 2025

View reviewed changes

a-mile and others added 2 commits July 24, 2025 09:40

Apply suggestions from code review

c361138

Co-authored-by: Eli Chadwick <[email protected]>

address review comments

53480fc

github-actions bot pushed a commit that referenced this pull request Jul 24, 2025

differences for PR #9

240a14c

reverted file renaming

61f2813

github-actions bot pushed a commit that referenced this pull request Jul 24, 2025

differences for PR #9

ddd4cb7

elichad reviewed Jul 25, 2025

View reviewed changes

resolve mixed-up filenames

97adeee

github-actions bot pushed a commit that referenced this pull request Jul 25, 2025

differences for PR #9

ba55f95

elichad reviewed Jul 25, 2025

View reviewed changes

move json comma callout to metadata description section

bf2f544

github-actions bot pushed a commit that referenced this pull request Jul 25, 2025

differences for PR #9

df5c486

elichad approved these changes Jul 25, 2025

View reviewed changes

elichad merged commit c82ddf7 into ResearchObject:main Jul 25, 2025
3 checks passed

Update references to 1.2 spec, re-ordering, content updates #9

Update references to 1.2 spec, re-ordering, content updates #9

Uh oh!

Conversation

a-mile commented Jul 23, 2025

Uh oh!

github-actions bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Thank you!

Rendered Changes

Uh oh!

a-mile commented Jul 23, 2025

Uh oh!

elichad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elichad Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

elichad Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

elichad Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

elichad left a comment

Choose a reason for hiding this comment

Uh oh!

elichad commented Jul 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Jul 23, 2025 •

edited

Loading